fix(document): repair Document.create after signatory serialization change#17
Closed
genaromadrid wants to merge 4 commits intomasterfrom
Closed
fix(document): repair Document.create after signatory serialization change#17genaromadrid wants to merge 4 commits intomasterfrom
genaromadrid wants to merge 4 commits intomasterfrom
Conversation
This PR fixes an issue where the SDK was incorrectly sending `allowed_signature_methods` as a Python string instead of a JSON array, causing a 500 Internal Server Error when using mixed signature types like `FEA` and `FESCV`. ### What’s changed - In the `Document.create()` method, the `allowed_signature_methods` field is now properly serialized using `json.dumps()` before being sent in the form data. ### Why The Mifiel API expects `allowed_signature_methods` to be a JSON array (e.g. `["FEA"]`), not a Python string like `"['FEA']"` or `"FEA,FESCV"`. The previous version of the SDK unintentionally broke this compatibility when posting multipart/form-data requests.
…part/form-data Previously, allowed_signature_methods was being serialized either as a plain string or using indexed keys (e.g., [0], [1]), which resulted in incorrect array parsing by the Mifiel API backend. This commit updates the serialization to use the `[]` syntax: signatories[0][allowed_signature_methods][]=FEA signatories[0][allowed_signature_methods][]=FESCV This is a widely supported format for arrays in multipart/form-data and ensures compatibility with the backend’s expected structure. Also removes the use of json.dumps, which was turning arrays into escaped strings instead of sending them as proper arrays.
Replaced internal data structure with a list of tuples to correctly handle multiple allowed_signature_methods for each signer in multipart/form-data. This change ensures repeated keys are preserved, allowing the backend to receive arrays like: signatories[0][allowed_signature_methods][]=FEA signatories[0][allowed_signature_methods][]=FESCV instead of silently overwriting values when using a dict.
Document.create mistakenly called dict.append when serializing signatories. Store scalar signatory fields on the dict, collect allowed_signature_methods as repeated bracket keys, then convert to a list of tuples for requests when needed. Apply callback_url and original_hash (dhash) before conversion so dict operations stay valid. Co-authored-by: Genaro Madrid <genaromadrid@users.noreply.github.com>
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Base automatically changed from
fix/serialize-allowed-signature-methods
to
master
April 22, 2026 16:58
Member
Author
|
already merged in #15 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Document.createwas callingdata.append(...)whiledatawas still adict, which raisedAttributeErrorand broke every create path (hash-only, file upload, timeout).Changes
datadict (signatories[i][key]).allowed_signature_methodslist values as repeatedsignatories[i][allowed_signature_methods][]entries.viewers,callback_url, andoriginal_hash(fromdhash), convertdatato a list of tuples plus the array-field tuples when needed sorequestssends duplicate field names correctly for multipart form posts.Testing
poetry run pytest— all 30 tests pass.This branch is intended to be merged into
fix/serialize-allowed-signature-methodsso PR #15 can pass CI.